Carbon


SoundComponentStopSource

Header: Sound.h Carbon status: Supported

Stops playing sounds in one or more sound channels. A sound output device component must implement the SoundComponentStopSource function.

ComponentResult SoundComponentStopSource (
    ComponentInstance ti, 
    SInt16 count, 
    SoundSource *sources
);
Parameter descriptions
ti

A component instance that identifies your sound component.

count

The number of source IDs in the array pointed to by the source parameter.

sources

An array of source IDs.

function result

Returns noErr if successful or an appropriate result code otherwise. You should return noErr even if no sounds are playing in the specified channels.

DISCUSSION

Your SoundComponentStopSource function is called by the Sound Manager to stop the sounds originating from the sound sources specified by the sources parameter. Your function should stop sending data from those sources to the associated sound output device. In addition, your SoundComponentStopSource function should flush any data from the specified sound sources that it’s caching. If your component supports only one sound source, you can ignore the sources parameter.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)